/*
 * Copyright 2013 Daniel Kurka
 * 
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License. You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software distributed under the License
 * is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
 * or implied. See the License for the specific language governing permissions and limitations under
 * the License.
 */
package com.googlecode.gwtdb.client.indexeddb;

import com.googlecode.gwtdb.client.indexeddb.exception.IDBDOMException;

public interface IDBCursor<K, V> {

  public enum CURSOR_DIRECTION {
    NEXT("next"), NEXT_UNIQUE("next_unique"), PREV("prev"), PREV_UNIQUE("prevunique");

    private final String direction;

    private CURSOR_DIRECTION(String direction) {
      this.direction = direction;

    }

    public String getDirection() {
      return direction;
    }
  }

  public Object getSource();/* IDBObjectStore or Index */

  public IDBRequest update(V value) throws IDBDOMException;

  public void advance(int count) throws IDBDOMException;

  public void doContinue();

  public void doContinue(IDBKey<K> key);

  public IDBRequest delete() throws IDBDOMException;

  public CURSOR_DIRECTION getDirection();

  /* TODO unclear */
  public IDBKey<K> getKey();

  /* TODO unclear */
  public IDBKey<K> getPrimaryKey();
}
